Skip to main content
Version: 24.03

Get a batch with a given batchId for a given orderId.

Get a batch with a given batchId for a given orderId.

Path Parameters
  • orderId uuid required

    Possible values: >= 36 characters and <= 36 characters

    Id of the order.

    Example: 6c311d29-5753-46d4-b32c-19b918ea93b0
  • batchId uuid required

    Possible values: >= 36 characters and <= 36 characters

    Id of the batch.

    Example: 4bce40b8-64c7-41bf-9ca3-e9432c7fef98
Responses

Get a batch with a given batchId for a given orderId.


Schema
  • batchId uuid

    Possible values: >= 36 characters and <= 36 characters, Value must match regular expression /^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i

    Id of the batch.

  • batchNumber int32

    Sequential number begins with first (1.) batch.

  • batchProcessingState string

    Possible values: [INITIALIZED, COMPLETED, PROCESSING, PARTIAL, ERROR]

    The state of the batch.

  • batchTotal int32

    The total number of batches.

  • completedOn date-time
  • jobs object[]

    Possible values: <= 2147483647

    Array of jobs.

  • completedOn date-time
  • id uuid
  • startedOn date-time
  • state string

    Possible values: [UNSAVED, INITIAL, RUNNING, TRANSFERS_FINISHED, COMPLETED, CANCELED, ERROR]

  • jobsInBatchChecksum int32

    Expected number of jobs in batch.

  • orderId uuid

    Possible values: >= 36 characters and <= 36 characters, Value must match regular expression /^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i

    Id of the order.

  • startedOn date-time
  • totalJobs int32

    Total amount of jobs inside the order.

Loading...